<?php

/*
 * Copyright 2008 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#namespace tehframework\request;

interface RequestParametersHolder
{
	/**
	 * @param  string $name
	 * @return bool
	 */
	function hasParameter($name);
	
	/**
	 * @param  string $name
	 * @return mixed
	 * @throws OutOfRangeException
	 */
	function getParameter($name);
	
	/**
	 * @return array<string,mixed>
	 */
	function getParameters();
	
	/**
	 * @param  string $name
	 * @param  mixed? $default
	 * @return mixed
	 */
	function tryGetParameter($name, $default = null);
	
	/**
	 * @param  string $name
	 * @param  mixed $value
	 * @return Request
	 * @throws BadMethodCallException
	 */
	function setParameter($name, $value);
	
	/**
	 * @param  array<string,mixed> $parameters
	 * @return Request
	 * @throws BadMethodCallException
	 */
	function setParameters(array $parameters);
	
	/**
	 * @param  string $name
	 * @return Request
	 * @throws OutOfRangeException
	 * @throws BadMethodCallException
	 */
	function removeParameter($name);
	
	/**
	 * @return Request
	 * @throws BadMethodCallException
	 */
	function clearParameters();
	
	/**
	 * @param  RequestParametersHolder $parametersHolder
	 * @return Request
	 * @throws BadMethodCallException
	 */
	function mergeParameters(RequestParametersHolder $parametersHolder);
}